<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>OrbbecSDK: /root/libobsensor/include/libobsensor/h/Error.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="orbbec_icon.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">OrbbecSDK
   &#160;<span id="projectnumber">1.10.22</span>
   </div>
   <div id="projectbrief">OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_8195f5c0d9a800b311ff87242d342361.html">libobsensor</a></li><li class="navelem"><a class="el" href="dir_9fda3634bd985c8b3aac4c1dd5078468.html">h</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Error.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Functions for handling errors, mainly used for obtaining error messages.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="ObTypes_8h_source.html">ObTypes.h</a>&quot;</code><br />
</div>
<p><a href="Error_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a52a52f63a64672df1716167876bd492c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ObTypes_8h.html#a2d4caae302682fc3cb8f8034bb99e229">ob_status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Error_8h.html#a52a52f63a64672df1716167876bd492c">ob_error_status</a> (<a class="el" href="structob__error.html">ob_error</a> *error)</td></tr>
<tr class="memdesc:a52a52f63a64672df1716167876bd492c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the error status.  <a href="#a52a52f63a64672df1716167876bd492c">More...</a><br /></td></tr>
<tr class="separator:a52a52f63a64672df1716167876bd492c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00a287f6ac69c3fd7a17aab13f6e54fb"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Error_8h.html#a00a287f6ac69c3fd7a17aab13f6e54fb">ob_error_message</a> (const <a class="el" href="structob__error.html">ob_error</a> *error)</td></tr>
<tr class="memdesc:a00a287f6ac69c3fd7a17aab13f6e54fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the error message.  <a href="#a00a287f6ac69c3fd7a17aab13f6e54fb">More...</a><br /></td></tr>
<tr class="separator:a00a287f6ac69c3fd7a17aab13f6e54fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1365826f2864b92af351a1e3b6c7d10d"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Error_8h.html#a1365826f2864b92af351a1e3b6c7d10d">ob_error_function</a> (<a class="el" href="structob__error.html">ob_error</a> *error)</td></tr>
<tr class="memdesc:a1365826f2864b92af351a1e3b6c7d10d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the API function that caused the error.  <a href="#a1365826f2864b92af351a1e3b6c7d10d">More...</a><br /></td></tr>
<tr class="separator:a1365826f2864b92af351a1e3b6c7d10d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa75bb01051d5e973475cfb6c9c48515d"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Error_8h.html#aa75bb01051d5e973475cfb6c9c48515d">ob_error_args</a> (<a class="el" href="structob__error.html">ob_error</a> *error)</td></tr>
<tr class="memdesc:aa75bb01051d5e973475cfb6c9c48515d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the error parameters.  <a href="#aa75bb01051d5e973475cfb6c9c48515d">More...</a><br /></td></tr>
<tr class="separator:aa75bb01051d5e973475cfb6c9c48515d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6218df5b2497f1f1fcca55a8214a51c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ObTypes_8h.html#ad131bb94383fdce36cb8aa91de5e0560">ob_exception_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Error_8h.html#a6218df5b2497f1f1fcca55a8214a51c4">ob_error_exception_type</a> (<a class="el" href="structob__error.html">ob_error</a> *error)</td></tr>
<tr class="memdesc:a6218df5b2497f1f1fcca55a8214a51c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the type of exception that caused the error.  <a href="#a6218df5b2497f1f1fcca55a8214a51c4">More...</a><br /></td></tr>
<tr class="separator:a6218df5b2497f1f1fcca55a8214a51c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc7c11095b7700c93427cd63747e15f8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Error_8h.html#afc7c11095b7700c93427cd63747e15f8">ob_delete_error</a> (<a class="el" href="structob__error.html">ob_error</a> *error)</td></tr>
<tr class="memdesc:afc7c11095b7700c93427cd63747e15f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete the error object.  <a href="#afc7c11095b7700c93427cd63747e15f8">More...</a><br /></td></tr>
<tr class="separator:afc7c11095b7700c93427cd63747e15f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Functions for handling errors, mainly used for obtaining error messages. </p>

<p>Definition in file <a class="el" href="Error_8h_source.html">Error.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a52a52f63a64672df1716167876bd492c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="ObTypes_8h.html#a2d4caae302682fc3cb8f8034bb99e229">ob_status</a> ob_error_status </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structob__error.html">ob_error</a> *&#160;</td>
          <td class="paramname"><em>error</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the error status. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">error</td><td>The error object. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The error status. </dd></dl>

</div>
</div>
<a class="anchor" id="a00a287f6ac69c3fd7a17aab13f6e54fb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* ob_error_message </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structob__error.html">ob_error</a> *&#160;</td>
          <td class="paramname"><em>error</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the error message. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">error</td><td>The error object. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The error message. </dd></dl>

</div>
</div>
<a class="anchor" id="a1365826f2864b92af351a1e3b6c7d10d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* ob_error_function </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structob__error.html">ob_error</a> *&#160;</td>
          <td class="paramname"><em>error</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the name of the API function that caused the error. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">error</td><td>The error object. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The name of the API function. </dd></dl>

</div>
</div>
<a class="anchor" id="aa75bb01051d5e973475cfb6c9c48515d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* ob_error_args </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structob__error.html">ob_error</a> *&#160;</td>
          <td class="paramname"><em>error</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the error parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">error</td><td>The error object. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The error parameters. </dd></dl>

</div>
</div>
<a class="anchor" id="a6218df5b2497f1f1fcca55a8214a51c4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="ObTypes_8h.html#ad131bb94383fdce36cb8aa91de5e0560">ob_exception_type</a> ob_error_exception_type </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structob__error.html">ob_error</a> *&#160;</td>
          <td class="paramname"><em>error</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the type of exception that caused the error. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">error</td><td>The error object. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The type of exception. </dd></dl>

</div>
</div>
<a class="anchor" id="afc7c11095b7700c93427cd63747e15f8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ob_delete_error </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structob__error.html">ob_error</a> *&#160;</td>
          <td class="paramname"><em>error</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Delete the error object. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">error</td><td>The error object to delete. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Apr 10 2025 12:28:22 for OrbbecSDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
